-
Notifications
You must be signed in to change notification settings - Fork 109
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs: Readme #2075
base: main
Are you sure you want to change the base?
Docs: Readme #2075
Conversation
Signed-off-by: Lubov66 <[email protected]>
WalkthroughThe changes involve the addition of a Discord badge in the Changes
Possibly related PRs
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@@ -19,6 +19,7 @@ _The project is still heavily under construction, see the [disclaimer below](#st | |||
[![CodeCov](https://codecov.io/gh/berachain/beacon-kit/graph/badge.svg?token=0l5iJ3ZbzV)](https://codecov.io/gh/berachain/beacon-kit) | |||
[![Telegram Chat](https://img.shields.io/endpoint?color=neon&logo=telegram&label=chat&url=https%3A%2F%2Ftg.sumanjay.workers.dev%2Fbeacon_kit)](https://t.me/beacon_kit) | |||
[![X Follow](https://img.shields.io/twitter/follow/berachain)](https://x.com/berachain) | |||
[![Discord](https://img.shields.io/discord/1067165013397213286?label=discord)](https://discord.com/invite/berachain) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧹 Nitpick (assertive)
LGTM! Consider adding alt text for accessibility.
The addition of the Discord badge is well-implemented:
- It uses a reputable badge service (img.shields.io).
- The link to the Discord server is correct.
- Its placement is appropriate, alongside other community-related badges.
- The style is consistent with other badges.
For improved accessibility, consider adding alt text to the badge. Here's a suggested modification:
[![Discord](https://img.shields.io/discord/1067165013397213286?label=discord)](https://discord.com/invite/berachain "Join our Discord server")
This change adds a descriptive title attribute to the link, which can improve the experience for users relying on screen readers.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm! @itsdevbear Should we merge this one ?
Added shields on Discord
Summary by CodeRabbit